Improve annotations documentation and rule references#1151
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This was referenced May 12, 2026
Closed
Closed
This was referenced May 16, 2026
Open
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Users configuring annotation-based rules reported that it was not obvious that
Meziantou.Analyzer.Annotationsis a separate package dependency. The docs now make that requirement explicit directly from each impacted rule page.What changed
MA0003,MA0011,MA0042,MA0045,MA0075,MA0076,MA0124,MA0139,MA0185src/Meziantou.Analyzer.Annotations/README.mdto serve as the central reference with:dotnet add package Meziantou.Analyzer.Annotations)publicorinternal).github/copilot-instructions.mdso changes undersrc/Meziantou.Analyzer.Annotationsrequire:src/Meziantou.Analyzer.Annotations/Meziantou.Analyzer.Annotations.csprojversion to1.3.1.Notes
This keeps documentation discoverability high from rule pages while using the package README as the single source of truth for annotation usage.